Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix command line examples to follow guidelines #28205

Merged
merged 4 commits into from
Jul 31, 2023
Merged

Fix command line examples to follow guidelines #28205

merged 4 commits into from
Jul 31, 2023

Conversation

queengooborg
Copy link
Collaborator

This PR fixes the command line examples to follow our guidelines not to include prompt symbols ($, >, etc.) and not to include the output directly in bash code examples. This also changes all codeblocks set to sh to use bash instead, which is what is more commonly used in MDN docs.

@queengooborg queengooborg requested review from a team as code owners July 26, 2023 23:48
@queengooborg queengooborg requested review from bsmth, wbamberg and teoli2003 and removed request for a team July 26, 2023 23:48
@github-actions github-actions bot added Content:WebAPI Web API docs Content:Learn Learning area docs Content:Learn:Django Learning area Django docs Content:Learn:Express Learning area Express docs Content:wasm WebAssembly docs Content:Glossary Glossary entries Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees Content:Meta Content in the meta docs labels Jul 26, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 26, 2023 •
edited
Loading

Preview URLs (15 pages)
Flaws (1)

Note! 14 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/Media_Source_Extensions_API/Transcoding_assets_for_MSE
Title: Transcoding assets for Media Source Extensions
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/MediaSource/isTypeSupported redirects to /en-US/docs/Web/API/MediaSource/isTypeSupported_static

(comment last updated: 2023-07-29 03:56:20)

bsmth
bsmth reviewed Jul 27, 2023
View reviewed changes
files/en-us/learn/server-side/django/development_environment/index.md Outdated
Comment on lines 111 to 113
```bash
python3 -V
Python 3.8.10
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like this is also okay, what do you think?

Suggested change
```bash
python3 -V
Python 3.8.10
```
```bash
python3 -V
# Python 3.8.10
```

bsmth
bsmth reviewed Jul 27, 2023
View reviewed changes
files/en-us/web/api/media_source_extensions_api/transcoding_assets_for_mse/index.md
ENCODING bitrate: 2000, resolution: 640x360

$ python mp4-dash.py video_0*
Parsing media file 1: video_00500.mp4
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sometimes the output is good to know what's the expected behavior, like this one. What do you think about keeping them in this PR but using a plain block after the command?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't too certain about including the output for these commands, but if you think they should be included, I'm down to re-add them!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one's tricky because it's three commands in sequence and we'll end up with six code blocks in total in place of one, so I'm not sure either. We could say, "you should have a directory structure like this" and only show the output of tree after, what do you think?

hamishwillee
hamishwillee approved these changes Jul 31, 2023
View reviewed changes
Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hard to keep up with all the additions to that list of supported code blocks https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN#example_code_blocks

@hamishwillee hamishwillee merged commit 6b01400 into main Jul 31, 2023
7 checks passed
@hamishwillee hamishwillee deleted the console-output branch July 31, 2023 00:02
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@rubiesonthesky rubiesonthesky rubiesonthesky left review comments

@bsmth bsmth bsmth left review comments

@hamishwillee hamishwillee hamishwillee approved these changes

@wbamberg wbamberg Awaiting requested review from wbamberg wbamberg is a code owner automatically assigned from mdn/yari-content-web-api

@teoli2003 teoli2003 Awaiting requested review from teoli2003 teoli2003 is a code owner automatically assigned from mdn/yari-content-http

Assignees
No one assigned
Labels
Content:Glossary Glossary entries Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees Content:Learn:Django Learning area Django docs Content:Learn:Express Learning area Express docs Content:Learn Learning area docs Content:Meta Content in the meta docs Content:wasm WebAssembly docs Content:WebAPI Web API docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@queengooborg @rubiesonthesky @hamishwillee @bsmth